3 * Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
23 use MediaWiki\MediaWikiServices
;
24 use MediaWiki\Revision\RevisionRecord
;
25 use MediaWiki\Storage\NameTableAccessException
;
28 * A query action to enumerate revisions of a given page, or show top revisions
29 * of multiple pages. Various pieces of information may be shown - flags,
30 * comments, and the actual wiki markup of the rev. In the enumeration mode,
31 * ranges of revisions may be requested and filtered.
35 class ApiQueryRevisions
extends ApiQueryRevisionsBase
{
37 private $token = null;
39 public function __construct( ApiQuery
$query, $moduleName ) {
40 parent
::__construct( $query, $moduleName, 'rv' );
43 private $tokenFunctions;
45 /** @deprecated since 1.24 */
46 protected function getTokenFunctions() {
47 // tokenname => function
48 // function prototype is func($pageid, $title, $rev)
49 // should return token or false
51 // Don't call the hooks twice
52 if ( isset( $this->tokenFunctions
) ) {
53 return $this->tokenFunctions
;
56 // If we're in a mode that breaks the same-origin policy, no tokens can
58 if ( $this->lacksSameOriginSecurity() ) {
62 $this->tokenFunctions
= [
63 'rollback' => [ self
::class, 'getRollbackToken' ]
65 Hooks
::run( 'APIQueryRevisionsTokens', [ &$this->tokenFunctions
] );
67 return $this->tokenFunctions
;
71 * @deprecated since 1.24
74 * @param Revision $rev
77 public static function getRollbackToken( $pageid, $title, $rev ) {
79 if ( !MediaWikiServices
::getInstance()->getPermissionManager()
80 ->userHasRight( $wgUser, 'rollback' ) ) {
84 return $wgUser->getEditToken( 'rollback' );
87 protected function run( ApiPageSet
$resultPageSet = null ) {
88 global $wgActorTableSchemaMigrationStage;
90 $params = $this->extractRequestParams( false );
91 $revisionStore = MediaWikiServices
::getInstance()->getRevisionStore();
93 // If any of those parameters are used, work in 'enumeration' mode.
94 // Enum mode can only be used when exactly one page is provided.
95 // Enumerating revisions on multiple pages make it extremely
96 // difficult to manage continuations and require additional SQL indexes
97 $enumRevMode = ( $params['user'] !== null ||
$params['excludeuser'] !== null ||
98 $params['limit'] !== null ||
$params['startid'] !== null ||
99 $params['endid'] !== null ||
$params['dir'] === 'newer' ||
100 $params['start'] !== null ||
$params['end'] !== null );
102 $pageSet = $this->getPageSet();
103 $pageCount = $pageSet->getGoodTitleCount();
104 $revCount = $pageSet->getRevisionCount();
106 // Optimization -- nothing to do
107 if ( $revCount === 0 && $pageCount === 0 ) {
111 if ( $revCount > 0 && count( $pageSet->getLiveRevisionIDs() ) === 0 ) {
112 // We're in revisions mode but all given revisions are deleted
116 if ( $revCount > 0 && $enumRevMode ) {
118 [ 'apierror-revisions-norevids', $this->getModulePrefix() ], 'invalidparammix'
122 if ( $pageCount > 1 && $enumRevMode ) {
124 [ 'apierror-revisions-singlepage', $this->getModulePrefix() ], 'invalidparammix'
128 // In non-enum mode, rvlimit can't be directly used. Use the maximum
130 if ( !$enumRevMode ) {
131 $this->setParsedLimit
= false;
132 $params['limit'] = 'max';
135 $db = $this->getDB();
138 $tsField = 'rev_timestamp';
139 $pageField = 'rev_page';
140 if ( $params['user'] !== null &&
141 ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_READ_NEW
)
143 // We're going to want to use the page_actor_timestamp index (on revision_actor_temp)
144 // so use that table's denormalized fields.
145 $idField = 'revactor_rev';
146 $tsField = 'revactor_timestamp';
147 $pageField = 'revactor_page';
150 if ( $resultPageSet === null ) {
151 $this->parseParameters( $params );
152 $this->token
= $params['token'];
154 if ( $this->token
!== null ||
$pageCount > 0 ) {
157 if ( $this->fld_user
) {
160 $revQuery = $revisionStore->getQueryInfo( $opts );
162 if ( $idField !== 'rev_id' ) {
163 $aliasFields = [ 'rev_id' => $idField, 'rev_timestamp' => $tsField, 'rev_page' => $pageField ];
164 $revQuery['fields'] = array_merge(
166 array_diff( $revQuery['fields'], array_keys( $aliasFields ) )
170 $this->addTables( $revQuery['tables'] );
171 $this->addFields( $revQuery['fields'] );
172 $this->addJoinConds( $revQuery['joins'] );
174 $this->limit
= $this->getParameter( 'limit' ) ?
: 10;
175 // Always join 'page' so orphaned revisions are filtered out
176 $this->addTables( [ 'revision', 'page' ] );
178 [ 'page' => [ 'JOIN', [ 'page_id = rev_page' ] ] ]
181 'rev_id' => $idField, 'rev_timestamp' => $tsField, 'rev_page' => $pageField
185 if ( $this->fld_tags
) {
186 $this->addFields( [ 'ts_tags' => ChangeTags
::makeTagSummarySubquery( 'revision' ) ] );
189 if ( $params['tag'] !== null ) {
190 $this->addTables( 'change_tag' );
192 [ 'change_tag' => [ 'JOIN', [ 'rev_id=ct_rev_id' ] ] ]
194 $changeTagDefStore = MediaWikiServices
::getInstance()->getChangeTagDefStore();
196 $this->addWhereFld( 'ct_tag_id', $changeTagDefStore->getId( $params['tag'] ) );
197 } catch ( NameTableAccessException
$exception ) {
199 $this->addWhere( '1=0' );
203 if ( $resultPageSet === null && $this->fetchContent
) {
204 // For each page we will request, the user must have read rights for that page
205 $status = Status
::newGood();
206 $user = $this->getUser();
208 /** @var Title $title */
209 foreach ( $pageSet->getGoodTitles() as $title ) {
210 if ( !$this->getPermissionManager()->userCan( 'read', $user, $title ) ) {
211 $status->fatal( ApiMessage
::create(
212 [ 'apierror-cannotviewtitle', wfEscapeWikiText( $title->getPrefixedText() ) ],
217 if ( !$status->isGood() ) {
218 $this->dieStatus( $status );
222 if ( $enumRevMode ) {
224 // page_timestamp if we don't have rvuser
225 // page_actor_timestamp (on revision_actor_temp) if we have rvuser in READ_NEW mode
226 // page_user_timestamp if we have a logged-in rvuser
227 // page_timestamp or usertext_timestamp if we have an IP rvuser
229 // This is mostly to prevent parameter errors (and optimize SQL?)
230 $this->requireMaxOneParameter( $params, 'startid', 'start' );
231 $this->requireMaxOneParameter( $params, 'endid', 'end' );
232 $this->requireMaxOneParameter( $params, 'user', 'excludeuser' );
234 if ( $params['continue'] !== null ) {
235 $cont = explode( '|', $params['continue'] );
236 $this->dieContinueUsageIf( count( $cont ) != 2 );
237 $op = ( $params['dir'] === 'newer' ?
'>' : '<' );
238 $continueTimestamp = $db->addQuotes( $db->timestamp( $cont[0] ) );
239 $continueId = (int)$cont[1];
240 $this->dieContinueUsageIf( $continueId != $cont[1] );
241 $this->addWhere( "$tsField $op $continueTimestamp OR " .
242 "($tsField = $continueTimestamp AND " .
243 "$idField $op= $continueId)"
247 // Convert startid/endid to timestamps (T163532)
249 if ( $params['startid'] !== null ) {
250 $revids[] = (int)$params['startid'];
252 if ( $params['endid'] !== null ) {
253 $revids[] = (int)$params['endid'];
256 $db = $this->getDB();
257 $sql = $db->unionQueries( [
260 [ 'id' => 'rev_id', 'ts' => 'rev_timestamp' ],
261 [ 'rev_id' => $revids ],
266 [ 'id' => 'ar_rev_id', 'ts' => 'ar_timestamp' ],
267 [ 'ar_rev_id' => $revids ],
270 ], $db::UNION_DISTINCT
);
271 $res = $db->query( $sql, __METHOD__
);
272 foreach ( $res as $row ) {
273 if ( (int)$row->id
=== (int)$params['startid'] ) {
274 $params['start'] = $row->ts
;
276 if ( (int)$row->id
=== (int)$params['endid'] ) {
277 $params['end'] = $row->ts
;
280 if ( $params['startid'] !== null && $params['start'] === null ) {
281 $p = $this->encodeParamName( 'startid' );
282 $this->dieWithError( [ 'apierror-revisions-badid', $p ], "badid_$p" );
284 if ( $params['endid'] !== null && $params['end'] === null ) {
285 $p = $this->encodeParamName( 'endid' );
286 $this->dieWithError( [ 'apierror-revisions-badid', $p ], "badid_$p" );
289 if ( $params['start'] !== null ) {
290 $op = ( $params['dir'] === 'newer' ?
'>' : '<' );
291 $ts = $db->addQuotes( $db->timestampOrNull( $params['start'] ) );
292 if ( $params['startid'] !== null ) {
293 $this->addWhere( "$tsField $op $ts OR "
294 . "$tsField = $ts AND $idField $op= " . (int)$params['startid'] );
296 $this->addWhere( "$tsField $op= $ts" );
299 if ( $params['end'] !== null ) {
300 $op = ( $params['dir'] === 'newer' ?
'<' : '>' ); // Yes, opposite of the above
301 $ts = $db->addQuotes( $db->timestampOrNull( $params['end'] ) );
302 if ( $params['endid'] !== null ) {
303 $this->addWhere( "$tsField $op $ts OR "
304 . "$tsField = $ts AND $idField $op= " . (int)$params['endid'] );
306 $this->addWhere( "$tsField $op= $ts" );
310 $this->addTimestampWhereRange( $tsField, $params['dir'],
311 $params['start'], $params['end'] );
314 $sort = ( $params['dir'] === 'newer' ?
'' : 'DESC' );
315 $this->addOption( 'ORDER BY', [ "rev_timestamp $sort", "rev_id $sort" ] );
317 // There is only one ID, use it
318 $ids = array_keys( $pageSet->getGoodTitles() );
319 $this->addWhereFld( $pageField, reset( $ids ) );
321 if ( $params['user'] !== null ) {
322 $actorQuery = ActorMigration
::newMigration()
323 ->getWhere( $db, 'rev_user', User
::newFromName( $params['user'], false ) );
324 $this->addTables( $actorQuery['tables'] );
325 $this->addJoinConds( $actorQuery['joins'] );
326 $this->addWhere( $actorQuery['conds'] );
327 } elseif ( $params['excludeuser'] !== null ) {
328 $actorQuery = ActorMigration
::newMigration()
329 ->getWhere( $db, 'rev_user', User
::newFromName( $params['excludeuser'], false ) );
330 $this->addTables( $actorQuery['tables'] );
331 $this->addJoinConds( $actorQuery['joins'] );
332 $this->addWhere( 'NOT(' . $actorQuery['conds'] . ')' );
334 if ( $params['user'] !== null ||
$params['excludeuser'] !== null ) {
335 // Paranoia: avoid brute force searches (T19342)
336 if ( !$this->getPermissionManager()->userHasRight( $this->getUser(), 'deletedhistory' ) ) {
337 $bitmask = RevisionRecord
::DELETED_USER
;
338 } elseif ( !$this->getPermissionManager()
339 ->userHasAnyRight( $this->getUser(), 'suppressrevision', 'viewsuppressed' )
341 $bitmask = RevisionRecord
::DELETED_USER | RevisionRecord
::DELETED_RESTRICTED
;
346 $this->addWhere( $db->bitAnd( 'rev_deleted', $bitmask ) . " != $bitmask" );
349 } elseif ( $revCount > 0 ) {
350 // Always targets the PRIMARY index
352 $revs = $pageSet->getLiveRevisionIDs();
354 // Get all revision IDs
355 $this->addWhereFld( 'rev_id', array_keys( $revs ) );
357 if ( $params['continue'] !== null ) {
358 $this->addWhere( 'rev_id >= ' . (int)$params['continue'] );
360 $this->addOption( 'ORDER BY', 'rev_id' );
361 } elseif ( $pageCount > 0 ) {
362 // Always targets the rev_page_id index
364 $titles = $pageSet->getGoodTitles();
366 // When working in multi-page non-enumeration mode,
367 // limit to the latest revision only
368 $this->addWhere( 'page_latest=rev_id' );
371 $this->addWhereFld( 'page_id', array_keys( $titles ) );
372 // Every time someone relies on equality propagation, god kills a kitten :)
373 $this->addWhereFld( 'rev_page', array_keys( $titles ) );
375 if ( $params['continue'] !== null ) {
376 $cont = explode( '|', $params['continue'] );
377 $this->dieContinueUsageIf( count( $cont ) != 2 );
378 $pageid = (int)$cont[0];
379 $revid = (int)$cont[1];
381 "rev_page > $pageid OR " .
382 "(rev_page = $pageid AND " .
386 $this->addOption( 'ORDER BY', [
391 ApiBase
::dieDebug( __METHOD__
, 'param validation?' );
394 $this->addOption( 'LIMIT', $this->limit +
1 );
396 // T224017: `rev_timestamp` is never the correct index to use for this module, but
397 // MariaDB (10.1.37-39) sometimes insists on trying to use it anyway. Tell it not to.
398 $this->addOption( 'IGNORE INDEX', [ 'revision' => 'rev_timestamp' ] );
403 $res = $this->select( __METHOD__
, [], $hookData );
405 foreach ( $res as $row ) {
406 if ( ++
$count > $this->limit
) {
407 // We've reached the one extra which shows that there are
408 // additional pages to be had. Stop here...
409 if ( $enumRevMode ) {
410 $this->setContinueEnumParameter( 'continue',
411 $row->rev_timestamp
. '|' . (int)$row->rev_id
);
412 } elseif ( $revCount > 0 ) {
413 $this->setContinueEnumParameter( 'continue', (int)$row->rev_id
);
415 $this->setContinueEnumParameter( 'continue', (int)$row->rev_page
.
416 '|' . (int)$row->rev_id
);
421 if ( $resultPageSet !== null ) {
422 $generated[] = $row->rev_id
;
424 $revision = $revisionStore->newRevisionFromRow( $row );
425 $rev = $this->extractRevisionInfo( $revision, $row );
427 if ( $this->token
!== null ) {
428 $title = Title
::newFromLinkTarget( $revision->getPageAsLinkTarget() );
429 $revisionCompat = new Revision( $revision );
430 $tokenFunctions = $this->getTokenFunctions();
431 foreach ( $this->token
as $t ) {
432 $val = call_user_func( $tokenFunctions[$t], $title->getArticleID(), $title, $revisionCompat );
433 if ( $val === false ) {
434 $this->addWarning( [ 'apiwarn-tokennotallowed', $t ] );
436 $rev[$t . 'token'] = $val;
441 $fit = $this->processRow( $row, $rev, $hookData ) &&
442 $this->addPageSubItem( $row->rev_page
, $rev, 'rev' );
444 if ( $enumRevMode ) {
445 $this->setContinueEnumParameter( 'continue',
446 $row->rev_timestamp
. '|' . (int)$row->rev_id
);
447 } elseif ( $revCount > 0 ) {
448 $this->setContinueEnumParameter( 'continue', (int)$row->rev_id
);
450 $this->setContinueEnumParameter( 'continue', (int)$row->rev_page
.
451 '|' . (int)$row->rev_id
);
458 if ( $resultPageSet !== null ) {
459 $resultPageSet->populateFromRevisionIDs( $generated );
463 public function getCacheMode( $params ) {
464 if ( isset( $params['token'] ) ) {
467 return parent
::getCacheMode( $params );
470 public function getAllowedParams() {
471 $ret = parent
::getAllowedParams() +
[
473 ApiBase
::PARAM_TYPE
=> 'integer',
474 ApiBase
::PARAM_HELP_MSG_INFO
=> [ [ 'singlepageonly' ] ],
477 ApiBase
::PARAM_TYPE
=> 'integer',
478 ApiBase
::PARAM_HELP_MSG_INFO
=> [ [ 'singlepageonly' ] ],
481 ApiBase
::PARAM_TYPE
=> 'timestamp',
482 ApiBase
::PARAM_HELP_MSG_INFO
=> [ [ 'singlepageonly' ] ],
485 ApiBase
::PARAM_TYPE
=> 'timestamp',
486 ApiBase
::PARAM_HELP_MSG_INFO
=> [ [ 'singlepageonly' ] ],
489 ApiBase
::PARAM_DFLT
=> 'older',
490 ApiBase
::PARAM_TYPE
=> [
494 ApiBase
::PARAM_HELP_MSG
=> 'api-help-param-direction',
495 ApiBase
::PARAM_HELP_MSG_INFO
=> [ [ 'singlepageonly' ] ],
498 ApiBase
::PARAM_TYPE
=> 'user',
499 ApiBase
::PARAM_HELP_MSG_INFO
=> [ [ 'singlepageonly' ] ],
502 ApiBase
::PARAM_TYPE
=> 'user',
503 ApiBase
::PARAM_HELP_MSG_INFO
=> [ [ 'singlepageonly' ] ],
507 ApiBase
::PARAM_DEPRECATED
=> true,
508 ApiBase
::PARAM_TYPE
=> array_keys( $this->getTokenFunctions() ),
509 ApiBase
::PARAM_ISMULTI
=> true
512 ApiBase
::PARAM_HELP_MSG
=> 'api-help-param-continue',
516 $ret['limit'][ApiBase
::PARAM_HELP_MSG_INFO
] = [ [ 'singlepageonly' ] ];
521 protected function getExamplesMessages() {
523 'action=query&prop=revisions&titles=API|Main%20Page&' .
524 'rvslots=*&rvprop=timestamp|user|comment|content'
525 => 'apihelp-query+revisions-example-content',
526 'action=query&prop=revisions&titles=Main%20Page&rvlimit=5&' .
527 'rvprop=timestamp|user|comment'
528 => 'apihelp-query+revisions-example-last5',
529 'action=query&prop=revisions&titles=Main%20Page&rvlimit=5&' .
530 'rvprop=timestamp|user|comment&rvdir=newer'
531 => 'apihelp-query+revisions-example-first5',
532 'action=query&prop=revisions&titles=Main%20Page&rvlimit=5&' .
533 'rvprop=timestamp|user|comment&rvdir=newer&rvstart=2006-05-01T00:00:00Z'
534 => 'apihelp-query+revisions-example-first5-after',
535 'action=query&prop=revisions&titles=Main%20Page&rvlimit=5&' .
536 'rvprop=timestamp|user|comment&rvexcludeuser=127.0.0.1'
537 => 'apihelp-query+revisions-example-first5-not-localhost',
538 'action=query&prop=revisions&titles=Main%20Page&rvlimit=5&' .
539 'rvprop=timestamp|user|comment&rvuser=MediaWiki%20default'
540 => 'apihelp-query+revisions-example-first5-user',
544 public function getHelpUrls() {
545 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Revisions';